Skip to content

Add NetEase Cloud Music provider docs (EN + ZH)#584

Merged
OzGav merged 1 commit intomusic-assistant:mainfrom
xiasi0:docs-netease-cloud-music
Apr 21, 2026
Merged

Add NetEase Cloud Music provider docs (EN + ZH)#584
OzGav merged 1 commit intomusic-assistant:mainfrom
xiasi0:docs-netease-cloud-music

Conversation

@xiasi0
Copy link
Copy Markdown
Contributor

@xiasi0 xiasi0 commented Apr 11, 2026

Summary

  • Add NetEase Cloud Music provider documentation in English and Chinese.
  • Add language switch links between EN/ZH pages.
  • Add provider icon asset and docs sidebar entry.
  • Document local API service requirement and QR login flow.

Related

Notes

  • This docs update reflects current integration behavior, including local NeteaseCloudMusicApi dependency and entitlement-based playback constraints.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 11, 2026

Deploy Preview for ohf-music-assistant ready!

Name Link
🔨 Latest commit 36707c2
🔍 Latest deploy log https://app.netlify.com/projects/ohf-music-assistant/deploys/69da5751a3e733000896dc5f
😎 Deploy Preview https://deploy-preview-584--ohf-music-assistant.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@xiasi0 xiasi0 force-pushed the docs-netease-cloud-music branch from 3972958 to 36707c2 Compare April 11, 2026 14:14
@xiasi0 xiasi0 marked this pull request as ready for review April 11, 2026 14:15
MarvinSchenkel pushed a commit to music-assistant/server that referenced this pull request Apr 20, 2026
## Summary
- Add a new NetEase Cloud Music provider for Music Assistant.
- Implement QR-code login flow (scan with NetEase Cloud Music app) and
provider setup UX.
- Implement core capabilities aligned with existing streaming providers:
library sync (artists/albums/tracks/playlists), search, playback,
recommendations, lyrics, and quality selection/fallback.
- Add dynamic recommendation entries for Private FM and Heart Mode, with
request/caching safeguards to avoid excessive refresh traffic.

## External Service Requirement
- This provider depends on a NeteaseCloudMusicApi-compatible backend
(`api_base_url`, default `http://127.0.0.1:3000`).
- The companion Home Assistant add-on is optional and only intended for
plug-and-play setup. It is not a hard project requirement.
- If the companion add-on is unavailable or blocked in some
environments, users can still run any compatible backend service
manually and keep using this provider.

## Compliance and Access Policy
- This provider integration itself does not implement unlock, bypass, or
crack logic for restricted content.
- Playback follows account permissions returned by the upstream API
service.
- For non-entitled content, behavior is constrained by upstream response
(preview/fallback), without circumvention.
- We are aware that upstream compatible API documentation mentions
capabilities related to forced requests for restricted content; this
provider does not use that path, and we have not implemented or tested
such behavior in this integration.

## Audio Quality Notes
- Quality is requested via a level ladder with graceful fallback based
on account and song entitlement.
- In testing, high-tier Master 192k can be obtained for eligible
advanced subscribers.
- Standard Hi-Res entitlement often resolves below expected 192k in
current upstream behavior; this path still needs further investigation.
- NetEase Hi-Res catalog spans multiple tiers (for example, ~48k to 192k
depending on track/entitlement), but this API path often does not return
the expected highest Hi-Res tier for regular subscriptions in current
testing.

## Related
- Music Assistant add-on PR (optional convenience deployment):
music-assistant/home-assistant-addon#16
- Music Assistant docs PR:
music-assistant/music-assistant.io#584

## Testing
- Local venv checks passed for provider scope (ruff, mypy, compile).
- Existing related provider tests passed (QQ Music and DLNA test
targets).
@OzGav OzGav merged commit 2943155 into music-assistant:main Apr 21, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants